/*
 * Copyright 2009 Johnson Consulting Services
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.johnsoncs.gwt.widgets.server.export;

import com.johnsoncs.gwt.widgets.client.dynamictable.export.ExportStatus;

/**
 * Defines a class capable of brokering ExportStatus objects between asynchronous export processes and consumers
 * In a non-clustered environment, this could simply write the export status to the HttpSession, while in a clustered environment a more complicated approach such as a database may be required.
 * @author wilj
 *
 */
public interface ExportStatusProxy {

	/**
	 * Deletes the export status from the implementation specific storage
	 * @param exportId the exportId associated with the ExportStatus to delete
	 */
	public void deleteExportStatus(String exportId);

	/**
	 * Retrieves the export status
	 * @param exportId the export transaction identifier
	 * @return ExportStatus for the request, or null if not found
	 */
	public ExportStatus getExportStatus(String exportId);

	/**
	 * Sets/upates the export status
	 * @param status the status to update
	 */
	public void setExportStatus(ExportStatus status);
}
